智简魔方文档

机房列表

本文说明智简魔方 DCIM 系统中“机房列表”相关的接口或函数信息,供开发人员在集成、调用和排查问题时参考。

概述

查询系统下的所有符合条件的机房信息。

URL

/index.php?m=api&a=houseListing

请求参数

字段名变量名必填类型描述
是否获取机柜cabinetboolean默认为 False,为 True 时返回机柜信息
搜索内容searchstring对机房信息的搜索
分页数量listpagesint每一页显示的数据的数量
排序类型orderbystring用来排序的字段
排序规则sortingstring升序 asc 降序 desc
数据偏移量offsetint返回数据的偏移指针,与分页数量结合使用

返回参数

字段名变量名类型描述
机房列表listingarray
id 机房ID
name 机房名称alias 机房别名remarks 备注信息ipmi_url 被控地址
ipmi_user 被控账号
ipmi_pass 被控KEY
dns1 机房DNS1dns2 机房DNS2vlan 机房临时vlanconn_status 连接状态(0:正常,1:异常)temp_vlan_status 临时vlan开关(0:关闭,1:开启)
auto_change_speed 自动限速开关(0:关闭,1:开启)auto_find_host 自动发现主机开关(0:关闭,1:开启)devicenum 设备总数cabinetnum 机柜总数cabinet 机柜详情(需设置cabinet true)
根据查询条件查询到的所有机房数据
机房总数sumint系统内机房数据的总数
分页数量listpagesint每一页显示的数据的数量
搜索内容searchstring自定义的搜索内容
排序类型orderbystring用来排序的字段
排序规则sortingstring升序 asc 降序 desc
数据偏移量offsetint返回数据的偏移指针,与分页数量结合使用
状态statusstringsuccess 成功 error 失败